Class CommandLogImpl

java.lang.Object
com.cisco.pt.ipc.impl.IPCObjectImpl
com.cisco.pt.ipc.system.impl.CommandLogImpl
All Implemented Interfaces:
IPCObject, CommandLog

public class CommandLogImpl extends IPCObjectImpl implements CommandLog
Information provided by the PKI file:

    \class CommandLog
    
    \brief CommandLog serves as the entry point to all command log objects.
    
    \example commandLog()
    
Author:
Auto-generated
  • Constructor Details

  • Method Details

    • clear

      public void clear()
      Information provided by the PKI file:
      
          \brief Clears the command log.
          
              
      Specified by:
      clear in interface CommandLog
    • setEnabled

      public void setEnabled(boolean enabled)
      Information provided by the PKI file:
      
          \brief Enables or disables the command log.
          
          \param enabled, true to enable the command log, false to disable it.
          
              
      Specified by:
      setEnabled in interface CommandLog
      Parameters:
      enabled - Takes in a parameter of enabled
    • isEnabled

      public boolean isEnabled()
      Information provided by the PKI file:
      
          \brief Returns true if the command log is enabled, otherwise false.
          
          \return bool, true if the command log is enabled, otherwise false.
          
              
      Specified by:
      isEnabled in interface CommandLog
      Returns:
      boolean Returns a boolean
    • getEntryCount

      public int getEntryCount()
      Information provided by the PKI file:
      
          \brief Returns the command log entry count.
          
          \return int, the command log entry count.
          
              
      Specified by:
      getEntryCount in interface CommandLog
      Returns:
      int Returns a int
    • getEntryAt

      public CommandLogEntry getEntryAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the CommandLogEntry object at the specified index.
          
          \param index, the index of the CommandLogEntry object of interest.
          
          \return CommandLogEntry, the CommandLogEntry object at the specified index.
          
              
      Specified by:
      getEntryAt in interface CommandLog
      Parameters:
      index - Takes in a parameter of index
      Returns:
      CommandLogEntry Returns a CommandLogEntry